home *** CD-ROM | disk | FTP | other *** search
/ Apple Developer Connection 1998 Fall: Game Toolkit / Disc.iso / SDKs / QuickTime Mac / AIncludes / QD3D.a < prev    next >
Encoding:
Text File  |  1998-04-09  |  37.5 KB  |  1,204 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        QD3D.a
  3. ;
  4. ;    Contains:    Base types for Quickdraw 3D                            
  5. ;
  6. ;    Version:    Technology:    Quickdraw 3D 1.5.4
  7. ;                Release:    QuickTime 3.0
  8. ;
  9. ;    Copyright:    © 1995-1998 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        Please include the the file and version information (from above) with
  12. ;                the problem description.  Developers belonging to one of the Apple
  13. ;                developer programs can submit bug reports to:
  14. ;
  15. ;                    devsupport@apple.com
  16. ;
  17. ;
  18.     IF &TYPE('__QD3D__') = 'UNDEFINED' THEN
  19. __QD3D__ SET 1
  20.  
  21.     IF &TYPE('__CONDITIONALMACROS__') = 'UNDEFINED' THEN
  22.     include 'ConditionalMacros.a'
  23.     ENDIF
  24.  
  25.     IF TARGET_OS_MAC THEN
  26.     IF &TYPE('__MACTYPES__') = 'UNDEFINED' THEN
  27.     include 'MacTypes.a'
  28.     ENDIF
  29.     ENDIF    ; TARGET_OS_MAC
  30.     IF TARGET_OS_MAC THEN
  31.     OS_MACINTOSH: SET 1
  32.     OS_WIN32: SET 0
  33.     OS_UNIX: SET 0
  34.     OS_NEXT: SET 0
  35.     WINDOW_SYSTEM_MACINTOSH: SET 1
  36.     WINDOW_SYSTEM_WIN32: SET 0
  37.     WINDOW_SYSTEM_X11: SET 0
  38.     WINDOW_SYSTEM_NEXT: SET 0
  39.     ENDIF    ; TARGET_OS_MAC
  40.  
  41. ; ******************************************************************************
  42. ; **                                                                             **
  43. ; **                                NULL definition                                 **
  44. ; **                                                                             **
  45. ; ****************************************************************************
  46.  
  47. ; ******************************************************************************
  48. ; **                                                                             **
  49. ; **                                    Objects                                     **
  50. ; **                                                                             **
  51. ; ****************************************************************************
  52.  
  53. ; 
  54. ; * Everything in QuickDraw 3D is an OBJECT: a bunch of data with a type,
  55. ; * deletion, duplication, and i/o methods.
  56. ; 
  57.  
  58. ; typedef long                             TQ3ObjectType
  59.  
  60.  
  61.  
  62. ;  
  63. ; 
  64. ; * There are four subclasses of OBJECT:
  65. ; *    an ELEMENT, which is data that is placed in a SET
  66. ; *    a SHAREDOBJECT, which is reference-counted data that is shared
  67. ; *    VIEWs, which maintain state information for an image
  68. ; *    a PICK, which used to query a VIEW
  69. ; 
  70.  
  71. ; typedef TQ3Object                     TQ3ElementObject
  72.  
  73. ; typedef TQ3Object                     TQ3SharedObject
  74.  
  75. ; typedef TQ3Object                     TQ3ViewObject
  76.  
  77. ; typedef TQ3Object                     TQ3PickObject
  78.  
  79. ; 
  80. ; * There are several types of SharedObjects:
  81. ; *    RENDERERs, which paint to a drawContext
  82. ; *    DRAWCONTEXTs, which are an interface to a device 
  83. ; *    SETs, which maintains "mathematical sets" of ELEMENTs
  84. ; *    FILEs, which maintain state information for a metafile
  85. ; *    SHAPEs, which affect the state of the View
  86. ; *    SHAPEPARTs, which contain geometry-specific data about a picking hit
  87. ; *    CONTROLLERSTATEs, which hold state of the output channels for a CONTROLLER
  88. ; *    TRACKERs, which represent a position and orientation in the user interface
  89. ; *  STRINGs, which are abstractions of text string data.
  90. ; *    STORAGE, which is an abstraction for stream-based data storage (files, memory)
  91. ; *    TEXTUREs, for sharing bitmap information for TEXTURESHADERS
  92. ; *    VIEWHINTs, which specifies viewing preferences in FILEs
  93. ; 
  94.  
  95. ; typedef TQ3SharedObject                 TQ3RendererObject
  96.  
  97. ; typedef TQ3SharedObject                 TQ3DrawContextObject
  98.  
  99. ; typedef TQ3SharedObject                 TQ3SetObject
  100.  
  101. ; typedef TQ3SharedObject                 TQ3FileObject
  102.  
  103. ; typedef TQ3SharedObject                 TQ3ShapeObject
  104.  
  105. ; typedef TQ3SharedObject                 TQ3ShapePartObject
  106.  
  107. ; typedef TQ3SharedObject                 TQ3ControllerStateObject
  108.  
  109. ; typedef TQ3SharedObject                 TQ3TrackerObject
  110.  
  111. ; typedef TQ3SharedObject                 TQ3StringObject
  112.  
  113. ; typedef TQ3SharedObject                 TQ3StorageObject
  114.  
  115. ; typedef TQ3SharedObject                 TQ3TextureObject
  116.  
  117. ; typedef TQ3SharedObject                 TQ3ViewHintsObject
  118.  
  119. ; 
  120. ; * There is one types of SET:
  121. ; *    ATTRIBUTESETs, which contain ATTRIBUTEs which are inherited 
  122. ; 
  123.  
  124. ; typedef TQ3SetObject                     TQ3AttributeSet
  125.  
  126. ; 
  127. ; * There are many types of SHAPEs:
  128. ; *    LIGHTs, which affect how the RENDERER draws 3-D cues
  129. ; *    CAMERAs, which affects the location and orientation of the RENDERER in space
  130. ; *    GROUPs, which may contain any number of SHARED OBJECTS
  131. ; *    GEOMETRYs, which are representations of three-dimensional data
  132. ; *    SHADERs, which affect how colors are drawn on a geometry
  133. ; *    STYLEs, which affect how the RENDERER paints to the DRAWCONTEXT
  134. ; *    TRANSFORMs, which affect the coordinate system in the VIEW
  135. ; *    REFERENCEs, which are references to objects in FILEs
  136. ; *  UNKNOWN, which hold unknown objects read from a metafile.
  137. ; 
  138.  
  139. ; typedef TQ3ShapeObject                 TQ3GroupObject
  140.  
  141. ; typedef TQ3ShapeObject                 TQ3GeometryObject
  142.  
  143. ; typedef TQ3ShapeObject                 TQ3ShaderObject
  144.  
  145. ; typedef TQ3ShapeObject                 TQ3StyleObject
  146.  
  147. ; typedef TQ3ShapeObject                 TQ3TransformObject
  148.  
  149. ; typedef TQ3ShapeObject                 TQ3LightObject
  150.  
  151. ; typedef TQ3ShapeObject                 TQ3CameraObject
  152.  
  153. ; typedef TQ3ShapeObject                 TQ3UnknownObject
  154.  
  155. ; typedef TQ3ShapeObject                 TQ3ReferenceObject
  156.  
  157. ; 
  158. ; * For now, there is only one type of SHAPEPARTs:
  159. ; *    MESHPARTs, which describe some part of a mesh
  160. ; 
  161.  
  162. ; typedef TQ3ShapePartObject             TQ3MeshPartObject
  163.  
  164. ; 
  165. ; * There are three types of MESHPARTs:
  166. ; *    MESHFACEPARTs, which describe a face of a mesh
  167. ; *    MESHEDGEPARTs, which describe a edge of a mesh
  168. ; *    MESHVERTEXPARTs, which describe a vertex of a mesh
  169. ; 
  170.  
  171. ; typedef TQ3MeshPartObject             TQ3MeshFacePartObject
  172.  
  173. ; typedef TQ3MeshPartObject             TQ3MeshEdgePartObject
  174.  
  175. ; typedef TQ3MeshPartObject             TQ3MeshVertexPartObject
  176.  
  177. ; 
  178. ; * A DISPLAY Group can be drawn to a view
  179. ; 
  180.  
  181. ; typedef TQ3GroupObject                 TQ3DisplayGroupObject
  182.  
  183. ; 
  184. ; * There are many types of SHADERs:
  185. ; *    SURFACESHADERs, which affect how the surface of a geometry is painted
  186. ; *    ILLUMINATIONSHADERs, which affect how lights affect the color of a surface
  187. ; 
  188.  
  189. ; typedef TQ3ShaderObject                 TQ3SurfaceShaderObject
  190.  
  191. ; typedef TQ3ShaderObject                 TQ3IlluminationShaderObject
  192.  
  193. ; 
  194. ; * A handle to an object in a group
  195. ; 
  196.  
  197.  
  198.  
  199. ;  
  200. ; * TQ3ObjectClassNameString is used for the class name of an object
  201. ; 
  202.  
  203.  
  204. kQ3StringMaximumLength            EQU        1024
  205. TQ3ObjectClassNameString RECORD 0
  206. elements                 ds.b    1024
  207. sizeof                     EQU *                    ; size:   $400 (1024)
  208.                         ENDR
  209.  
  210.  
  211. ; ******************************************************************************
  212. ; **                                                                             **
  213. ; **                            Client/Server Things                             **
  214. ; **                                                                             **
  215. ; ****************************************************************************
  216.  
  217. ; typedef void *                        TQ3ControllerRef
  218.  
  219. ; ******************************************************************************
  220. ; **                                                                             **
  221. ; **                            Flags and Switches                                 **
  222. ; **                                                                             **
  223. ; ****************************************************************************
  224.  
  225.  
  226. ; typedef long                            TQ3Boolean
  227. kQ3False                        EQU        0
  228. kQ3True                            EQU        1
  229.  
  230. ; typedef long                            TQ3Switch
  231. kQ3Off                            EQU        0
  232. kQ3On                            EQU        1
  233.  
  234. ; typedef long                            TQ3Status
  235. kQ3Failure                        EQU        0
  236. kQ3Success                        EQU        1
  237.  
  238. ; typedef long                            TQ3Axis
  239. kQ3AxisX                        EQU        0
  240. kQ3AxisY                        EQU        1
  241. kQ3AxisZ                        EQU        2
  242.  
  243. ; typedef long                            TQ3PixelType
  244. kQ3PixelTypeRGB32                EQU        0                    ; Alpha:8 (ignored), R:8, G:8, B:8    
  245. kQ3PixelTypeARGB32                EQU        1                    ; Alpha:8, R:8, G:8, B:8             
  246. kQ3PixelTypeRGB16                EQU        2                    ; Alpha:1 (ignored), R:5, G:5, B:5    
  247. kQ3PixelTypeARGB16                EQU        3                    ; Alpha:1, R:5, G:5, B:5             
  248. kQ3PixelTypeRGB16_565            EQU        4                    ; Win32 only: 16 bits/pixel, R:5, G:6, B:5        
  249. kQ3PixelTypeRGB24                EQU        5                    ; Win32 only: 24 bits/pixel, R:8, G:8, B:8        
  250.  
  251. ; typedef long                            TQ3Endian
  252. kQ3EndianBig                    EQU        0
  253. kQ3EndianLittle                    EQU        1
  254.  
  255. ; typedef long                            TQ3EndCapMasks
  256. kQ3EndCapNone                    EQU        0
  257. kQ3EndCapMaskTop                EQU        $01
  258. kQ3EndCapMaskBottom                EQU        $02
  259. kQ3EndCapMaskInterior            EQU        $04
  260. ; typedef unsigned long                 TQ3EndCap
  261.  
  262.  
  263. kQ3ArrayIndexNULL                EQU        -1
  264. ; ******************************************************************************
  265. ; **                                                                             **
  266. ; **                        Point and Vector Definitions                         **
  267. ; **                                                                             **
  268. ; ****************************************************************************
  269.  
  270. TQ3Vector2D                RECORD 0
  271. x                         ds        Float32            ; offset: $0 (0)
  272. y                         ds        Float32            ; offset: $4 (4)
  273. sizeof                     EQU *                    ; size:   $8 (8)
  274.                         ENDR
  275. TQ3Vector3D                RECORD 0
  276. x                         ds        Float32            ; offset: $0 (0)
  277. y                         ds        Float32            ; offset: $4 (4)
  278. z                         ds        Float32            ; offset: $8 (8)
  279. sizeof                     EQU *                    ; size:   $C (12)
  280.                         ENDR
  281. TQ3Point2D                RECORD 0
  282. x                         ds        Float32            ; offset: $0 (0)
  283. y                         ds        Float32            ; offset: $4 (4)
  284. sizeof                     EQU *                    ; size:   $8 (8)
  285.                         ENDR
  286. TQ3Point3D                RECORD 0
  287. x                         ds        Float32            ; offset: $0 (0)
  288. y                         ds        Float32            ; offset: $4 (4)
  289. z                         ds        Float32            ; offset: $8 (8)
  290. sizeof                     EQU *                    ; size:   $C (12)
  291.                         ENDR
  292. TQ3RationalPoint4D        RECORD 0
  293. x                         ds        Float32            ; offset: $0 (0)
  294. y                         ds        Float32            ; offset: $4 (4)
  295. z                         ds        Float32            ; offset: $8 (8)
  296. w                         ds        Float32            ; offset: $C (12)
  297. sizeof                     EQU *                    ; size:   $10 (16)
  298.                         ENDR
  299. TQ3RationalPoint3D        RECORD 0
  300. x                         ds        Float32            ; offset: $0 (0)
  301. y                         ds        Float32            ; offset: $4 (4)
  302. w                         ds        Float32            ; offset: $8 (8)
  303. sizeof                     EQU *                    ; size:   $C (12)
  304.                         ENDR
  305. ; ******************************************************************************
  306. ; **                                                                             **
  307. ; **                                Quaternion                                     **
  308. ; **                                                                             **
  309. ; ****************************************************************************
  310.  
  311. TQ3Quaternion            RECORD 0
  312. w                         ds        Float32            ; offset: $0 (0)
  313. x                         ds        Float32            ; offset: $4 (4)
  314. y                         ds        Float32            ; offset: $8 (8)
  315. z                         ds        Float32            ; offset: $C (12)
  316. sizeof                     EQU *                    ; size:   $10 (16)
  317.                         ENDR
  318. ; ******************************************************************************
  319. ; **                                                                             **
  320. ; **                                Ray Definition                                 **
  321. ; **                                                                             **
  322. ; ****************************************************************************
  323.  
  324. TQ3Ray3D                RECORD 0
  325. origin                     ds        TQ3Point3D        ; offset: $0 (0)
  326. direction                 ds        TQ3Vector3D        ; offset: $C (12)
  327. sizeof                     EQU *                    ; size:   $18 (24)
  328.                         ENDR
  329. ; ******************************************************************************
  330. ; **                                                                             **
  331. ; **                        Parameterization Data Structures                     **
  332. ; **                                                                             **
  333. ; ****************************************************************************
  334.  
  335. TQ3Param2D                RECORD 0
  336. u                         ds        Float32            ; offset: $0 (0)
  337. v                         ds        Float32            ; offset: $4 (4)
  338. sizeof                     EQU *                    ; size:   $8 (8)
  339.                         ENDR
  340. TQ3Param3D                RECORD 0
  341. u                         ds        Float32            ; offset: $0 (0)
  342. v                         ds        Float32            ; offset: $4 (4)
  343. w                         ds        Float32            ; offset: $8 (8)
  344. sizeof                     EQU *                    ; size:   $C (12)
  345.                         ENDR
  346. TQ3Tangent2D            RECORD 0
  347. uTangent                 ds        TQ3Vector3D        ; offset: $0 (0)
  348. vTangent                 ds        TQ3Vector3D        ; offset: $C (12)
  349. sizeof                     EQU *                    ; size:   $18 (24)
  350.                         ENDR
  351. TQ3Tangent3D            RECORD 0
  352. uTangent                 ds        TQ3Vector3D        ; offset: $0 (0)
  353. vTangent                 ds        TQ3Vector3D        ; offset: $C (12)
  354. wTangent                 ds        TQ3Vector3D        ; offset: $18 (24)
  355. sizeof                     EQU *                    ; size:   $24 (36)
  356.                         ENDR
  357. ; ******************************************************************************
  358. ; **                                                                             **
  359. ; **                        Polar and Spherical Coordinates                         **
  360. ; **                                                                             **
  361. ; ****************************************************************************
  362.  
  363. TQ3PolarPoint            RECORD 0
  364. r                         ds        Float32            ; offset: $0 (0)
  365. theta                     ds        Float32            ; offset: $4 (4)
  366. sizeof                     EQU *                    ; size:   $8 (8)
  367.                         ENDR
  368. TQ3SphericalPoint        RECORD 0
  369. rho                         ds        Float32            ; offset: $0 (0)
  370. theta                     ds        Float32            ; offset: $4 (4)
  371. phi                         ds        Float32            ; offset: $8 (8)
  372. sizeof                     EQU *                    ; size:   $C (12)
  373.                         ENDR
  374. ; ******************************************************************************
  375. ; **                                                                             **
  376. ; **                            Color Definition                                 **
  377. ; **                                                                             **
  378. ; ****************************************************************************
  379.  
  380. TQ3ColorRGB                RECORD 0
  381. r                         ds        Float32            ; offset: $0 (0)
  382. g                         ds        Float32            ; offset: $4 (4)
  383. b                         ds        Float32            ; offset: $8 (8)
  384. sizeof                     EQU *                    ; size:   $C (12)
  385.                         ENDR
  386. TQ3ColorARGB            RECORD 0
  387. a                         ds        Float32            ; offset: $0 (0)
  388. r                         ds        Float32            ; offset: $4 (4)
  389. g                         ds        Float32            ; offset: $8 (8)
  390. b                         ds        Float32            ; offset: $C (12)
  391. sizeof                     EQU *                    ; size:   $10 (16)
  392.                         ENDR
  393. ; ******************************************************************************
  394. ; **                                                                             **
  395. ; **                                    Vertices                                 **
  396. ; **                                                                             **
  397. ; ****************************************************************************
  398.  
  399. TQ3Vertex3D                RECORD 0
  400. point                     ds        TQ3Point3D        ; offset: $0 (0)
  401. attributeSet             ds.l    1                ; offset: $C (12)
  402. sizeof                     EQU *                    ; size:   $10 (16)
  403.                         ENDR
  404. ; ******************************************************************************
  405. ; **                                                                             **
  406. ; **                                    Matrices                                 **
  407. ; **                                                                             **
  408. ; ****************************************************************************
  409.  
  410. TQ3Matrix3x3            RECORD 0
  411. value                     ds.b    3 * 3 * Float32.sizeof ; offset: $0 (0)
  412. sizeof                     EQU *                    ; size:   $24 (36)
  413.                         ENDR
  414. TQ3Matrix4x4            RECORD 0
  415. value                     ds.b    4 * 4 * Float32.sizeof ; offset: $0 (0)
  416. sizeof                     EQU *                    ; size:   $40 (64)
  417.                         ENDR
  418. ; ******************************************************************************
  419. ; **                                                                             **
  420. ; **                                Bitmap/Pixmap                                 **
  421. ; **                                                                             **
  422. ; ****************************************************************************
  423.  
  424. TQ3Pixmap                RECORD 0
  425. image                     ds.l    1                ; offset: $0 (0)
  426. width                     ds.l    1                ; offset: $4 (4)
  427. height                     ds.l    1                ; offset: $8 (8)
  428. rowBytes                 ds.l    1                ; offset: $C (12)
  429. pixelSize                 ds.l    1                ; offset: $10 (16)        ;  MUST be 16 or 32 to use with the    Interactive Renderer on Mac OS
  430. pixelType                 ds.l    1                ; offset: $14 (20)
  431. bitOrder                 ds.l    1                ; offset: $18 (24)
  432. byteOrder                 ds.l    1                ; offset: $1C (28)
  433. sizeof                     EQU *                    ; size:   $20 (32)
  434.                         ENDR
  435. TQ3StoragePixmap        RECORD 0
  436. image                     ds.l    1                ; offset: $0 (0)
  437. width                     ds.l    1                ; offset: $4 (4)
  438. height                     ds.l    1                ; offset: $8 (8)
  439. rowBytes                 ds.l    1                ; offset: $C (12)
  440. pixelSize                 ds.l    1                ; offset: $10 (16)        ;  MUST be 16 or 32 to use with the    Interactive Renderer on Mac OS
  441. pixelType                 ds.l    1                ; offset: $14 (20)
  442. bitOrder                 ds.l    1                ; offset: $18 (24)
  443. byteOrder                 ds.l    1                ; offset: $1C (28)
  444. sizeof                     EQU *                    ; size:   $20 (32)
  445.                         ENDR
  446. TQ3Bitmap                RECORD 0
  447. image                     ds.l    1                ; offset: $0 (0)
  448. width                     ds.l    1                ; offset: $4 (4)
  449. height                     ds.l    1                ; offset: $8 (8)
  450. rowBytes                 ds.l    1                ; offset: $C (12)
  451. bitOrder                 ds.l    1                ; offset: $10 (16)
  452. sizeof                     EQU *                    ; size:   $14 (20)
  453.                         ENDR
  454. TQ3MipmapImage            RECORD 0
  455. ;  An image for use as a texture mipmap  
  456. width                     ds.l    1                ; offset: $0 (0)        ;  Width of mipmap, must be power of 2   
  457. height                     ds.l    1                ; offset: $4 (4)        ;  Height of mipmap, must be power of 2  
  458. rowBytes                 ds.l    1                ; offset: $8 (8)        ;  Rowbytes of mipmap                    
  459. offset                     ds.l    1                ; offset: $C (12)        ;  Offset from image base to this mipmap 
  460. sizeof                     EQU *                    ; size:   $10 (16)
  461.                         ENDR
  462. TQ3Mipmap                RECORD 0
  463. image                     ds.l    1                ; offset: $0 (0)        ;  Data containing the texture map and      
  464. ;  if (useMipmapping==kQ3True) the          
  465. ;  mipmap data                              
  466. useMipmapping             ds.l    1                ; offset: $4 (4)        ;  True if mipmapping should be used      
  467. ;  and all mipmaps have been provided    
  468. pixelType                 ds.l    1                ; offset: $8 (8)
  469. bitOrder                 ds.l    1                ; offset: $C (12)
  470. byteOrder                 ds.l    1                ; offset: $10 (16)
  471. reserved                 ds.l    1                ; offset: $14 (20)        ;  leave NULL for next version             
  472. mipmaps                     ds.b    32 * TQ3MipmapImage.sizeof ; offset: $18 (24) ;  The actual number of mipmaps is determined from the size of the first mipmap 
  473. sizeof                     EQU *                    ; size:   $218 (536)
  474.                         ENDR
  475.  
  476. ; ******************************************************************************
  477. ; **                                                                             **
  478. ; **                        Higher dimension quantities                             **
  479. ; **                                                                             **
  480. ; ****************************************************************************
  481.  
  482. TQ3Area                    RECORD 0
  483. min                         ds        TQ3Point2D        ; offset: $0 (0)
  484. max                         ds        TQ3Point2D        ; offset: $8 (8)
  485. sizeof                     EQU *                    ; size:   $10 (16)
  486.                         ENDR
  487. TQ3PlaneEquation        RECORD 0
  488. normal                     ds        TQ3Vector3D        ; offset: $0 (0)
  489. constant                 ds        Float32            ; offset: $C (12)
  490. sizeof                     EQU *                    ; size:   $10 (16)
  491.                         ENDR
  492. TQ3BoundingBox            RECORD 0
  493. min                         ds        TQ3Point3D        ; offset: $0 (0)
  494. max                         ds        TQ3Point3D        ; offset: $C (12)
  495. isEmpty                     ds.l    1                ; offset: $18 (24)
  496. sizeof                     EQU *                    ; size:   $1C (28)
  497.                         ENDR
  498. TQ3BoundingSphere        RECORD 0
  499. origin                     ds        TQ3Point3D        ; offset: $0 (0)
  500. radius                     ds        Float32            ; offset: $C (12)
  501. isEmpty                     ds.l    1                ; offset: $10 (16)
  502. sizeof                     EQU *                    ; size:   $14 (20)
  503.                         ENDR
  504. ; 
  505. ; *    The TQ3ComputeBounds flag passed to StartBoundingBox or StartBoundingSphere
  506. ; *    calls in the View. It's a hint to the system as to how it should 
  507. ; *    compute the bbox of a shape:
  508. ; *
  509. ; *    kQ3ComputeBoundsExact:    
  510. ; *        Vertices of shapes are transformed into world space and
  511. ; *        the world space bounding box is computed from them.  Slow!
  512. ; *    
  513. ; *    kQ3ComputeBoundsApproximate: 
  514. ; *        A local space bounding box is computed from a shape's
  515. ; *        vertices.  This bbox is then transformed into world space,
  516. ; *        and its bounding box is taken as the shape's approximate
  517. ; *        bbox.  Fast but the bbox is larger than optimal.
  518. ; 
  519.  
  520.  
  521. ; typedef long                            TQ3ComputeBounds
  522. kQ3ComputeBoundsExact            EQU        0
  523. kQ3ComputeBoundsApproximate        EQU        1
  524.  
  525. ; ******************************************************************************
  526. ; **                                                                             **
  527. ; **                            Object System Types                                 **
  528. ; **                                                                             **
  529. ; ****************************************************************************
  530.  
  531.  
  532.  
  533.  
  534. ; typedef unsigned long                 TQ3XMethodType
  535.  
  536. ; 
  537. ; * Object methods
  538. ; 
  539.  
  540. ;  
  541. ; *  Return true from the metahandler if this 
  542. ; *  object can be submitted in a rendering loop 
  543. ; 
  544.  
  545. ; 
  546. ; * MetaHandler:
  547. ; *        When you give a metahandler to QuickDraw 3D, it is called multiple 
  548. ; *        times to build method tables, and then is thrown away. You are 
  549. ; *        guaranteed that your metahandler will never be called again after a 
  550. ; *        call that was passed a metahandler returns.
  551. ; *
  552. ; *        Your metahandler should contain a switch on the methodType passed to it
  553. ; *        and should return the corresponding method as an TQ3XFunctionPointer.
  554. ; *
  555. ; *        IMPORTANT: A metaHandler MUST always "return" a value. If you are
  556. ; *        passed a methodType that you do not understand, ALWAYS return NULL.
  557. ; *
  558. ; *        These types here are prototypes of how your functions should look.
  559. ; 
  560.  
  561. ; 
  562. ; * See QD3DIO.h for the IO method types: 
  563. ; *        ObjectReadData, ObjectTraverse, ObjectWrite
  564. ; 
  565.  
  566.  
  567. ; ******************************************************************************
  568. ; **                                                                             **
  569. ; **                                Set Types                                     **
  570. ; **                                                                             **
  571. ; ****************************************************************************
  572.  
  573. ; typedef long                             TQ3ElementType
  574.  
  575.  
  576. kQ3ElementTypeNone                EQU        0
  577. kQ3ElementTypeUnknown            EQU        32
  578. kQ3ElementTypeSet                EQU        33
  579.  
  580. ;  
  581. ; *    kQ3ElementTypeUnknown is a TQ3Object. 
  582. ; *    
  583. ; *        Do Q3Set_Add(s, ..., &obj) or Q3Set_Get(s, ..., &obj);
  584. ; *        
  585. ; *        Note that the object is always referenced when copying around. 
  586. ; *        
  587. ; *        Generally, it is an Unknown object, a Group of Unknown objects, or a 
  588. ; *        group of other "objects" which have been found in the metafile and
  589. ; *        have no attachment method to their parent. Be prepared to handle
  590. ; *        any or all of these cases if you actually access the set on a shape.
  591. ; *
  592. ; *    kQ3ElementTypeSet is a TQ3SetObject. 
  593. ; *    
  594. ; *        Q3Shape_GetSet(s,&o) is eqivalent to 
  595. ; *            Q3Shape_GetElement(s, kQ3ElementTypeSet, &o)
  596. ; *            
  597. ; *        Q3Shape_SetSet(s,o)  is eqivalent to 
  598. ; *            Q3Shape_SetElement(s, kQ3ElementTypeSet, &o)
  599. ; *    
  600. ; *        Note that the object is always referenced when copying around. 
  601. ; *        
  602. ; *    See the note below about the Set and Shape changes.
  603. ; 
  604.  
  605.  
  606. ; ******************************************************************************
  607. ; **                                                                             **
  608. ; **                            Object System Macros                             **
  609. ; **                                                                             **
  610. ; ****************************************************************************
  611.  
  612. ; ******************************************************************************
  613. ; **                                                                             **
  614. ; **                                Object Types                                 **
  615. ; **                                                                             **
  616. ; ****************************************************************************
  617.  
  618. ; 
  619. ; * Note:    a call to Q3Foo_GetType will return a value kQ3FooTypeBar
  620. ; *            e.g. Q3Shared_GetType(object) returns kQ3SharedTypeShape, etc.
  621. ; 
  622.  
  623.  
  624.  
  625. kQ3ObjectTypeInvalid            EQU        0
  626. kQ3ObjectTypeView                EQU        'view'
  627. kQ3ObjectTypeElement            EQU        'elmn'
  628. kQ3ElementTypeAttribute            EQU        'eatt'
  629. kQ3ObjectTypePick                EQU        'pick'
  630. kQ3PickTypeWindowPoint            EQU        'pkwp'
  631. kQ3PickTypeWindowRect            EQU        'pkwr'
  632. kQ3ObjectTypeShared                EQU        'shrd'
  633. kQ3SharedTypeRenderer            EQU        'rddr'
  634. kQ3RendererTypeWireFrame        EQU        'wrfr'
  635. kQ3RendererTypeGeneric            EQU        'gnrr'
  636. kQ3RendererTypeInteractive        EQU        'ctwn'
  637. kQ3SharedTypeShape                EQU        'shap'
  638. kQ3ShapeTypeGeometry            EQU        'gmtr'
  639. kQ3GeometryTypeBox                EQU        'box '
  640. kQ3GeometryTypeGeneralPolygon    EQU        'gpgn'
  641. kQ3GeometryTypeLine                EQU        'line'
  642. kQ3GeometryTypeMarker            EQU        'mrkr'
  643. kQ3GeometryTypePixmapMarker        EQU        'mrkp'
  644. kQ3GeometryTypeMesh                EQU        'mesh'
  645. kQ3GeometryTypeNURBCurve        EQU        'nrbc'
  646. kQ3GeometryTypeNURBPatch        EQU        'nrbp'
  647. kQ3GeometryTypePoint            EQU        'pnt '
  648. kQ3GeometryTypePolygon            EQU        'plyg'
  649. kQ3GeometryTypePolyLine            EQU        'plyl'
  650. kQ3GeometryTypeTriangle            EQU        'trng'
  651. kQ3GeometryTypeTriGrid            EQU        'trig'
  652. kQ3GeometryTypeCone                EQU        'cone'
  653. kQ3GeometryTypeCylinder            EQU        'cyln'
  654. kQ3GeometryTypeDisk                EQU        'disk'
  655. kQ3GeometryTypeEllipse            EQU        'elps'
  656. kQ3GeometryTypeEllipsoid        EQU        'elpd'
  657. kQ3GeometryTypePolyhedron        EQU        'plhd'
  658. kQ3GeometryTypeTorus            EQU        'tors'
  659. kQ3GeometryTypeTriMesh            EQU        'tmsh'
  660. kQ3ShapeTypeShader                EQU        'shdr'
  661. kQ3ShaderTypeSurface            EQU        'sush'
  662. kQ3SurfaceShaderTypeTexture        EQU        'txsu'
  663. kQ3ShaderTypeIllumination        EQU        'ilsh'
  664. kQ3IlluminationTypePhong        EQU        'phil'
  665. kQ3IlluminationTypeLambert        EQU        'lmil'
  666. kQ3IlluminationTypeNULL            EQU        'nuil'
  667. kQ3ShapeTypeStyle                EQU        'styl'
  668. kQ3StyleTypeBackfacing            EQU        'bckf'
  669. kQ3StyleTypeInterpolation        EQU        'intp'
  670. kQ3StyleTypeFill                EQU        'fist'
  671. kQ3StyleTypePickID                EQU        'pkid'
  672. kQ3StyleTypeReceiveShadows        EQU        'rcsh'
  673. kQ3StyleTypeHighlight            EQU        'high'
  674. kQ3StyleTypeSubdivision            EQU        'sbdv'
  675. kQ3StyleTypeOrientation            EQU        'ofdr'
  676. kQ3StyleTypePickParts            EQU        'pkpt'
  677. kQ3StyleTypeAntiAlias            EQU        'anti'
  678. kQ3ShapeTypeTransform            EQU        'xfrm'
  679. kQ3TransformTypeMatrix            EQU        'mtrx'
  680. kQ3TransformTypeScale            EQU        'scal'
  681. kQ3TransformTypeTranslate        EQU        'trns'
  682. kQ3TransformTypeRotate            EQU        'rott'
  683. kQ3TransformTypeRotateAboutPoint EQU    'rtap'
  684. kQ3TransformTypeRotateAboutAxis    EQU        'rtaa'
  685. kQ3TransformTypeQuaternion        EQU        'qtrn'
  686. kQ3TransformTypeReset            EQU        'rset'
  687. kQ3ShapeTypeLight                EQU        'lght'
  688. kQ3LightTypeAmbient                EQU        'ambn'
  689. kQ3LightTypeDirectional            EQU        'drct'
  690. kQ3LightTypePoint                EQU        'pntl'
  691. kQ3LightTypeSpot                EQU        'spot'
  692. kQ3ShapeTypeCamera                EQU        'cmra'
  693. kQ3CameraTypeOrthographic        EQU        'orth'
  694. kQ3CameraTypeViewPlane            EQU        'vwpl'
  695. kQ3CameraTypeViewAngleAspect    EQU        'vana'
  696. kQ3ShapeTypeGroup                EQU        'grup'
  697. kQ3GroupTypeDisplay                EQU        'dspg'
  698. kQ3DisplayGroupTypeOrdered        EQU        'ordg'
  699. kQ3DisplayGroupTypeIOProxy        EQU        'iopx'
  700. kQ3GroupTypeLight                EQU        'lghg'
  701. kQ3GroupTypeInfo                EQU        'info'
  702. kQ3ShapeTypeUnknown                EQU        'unkn'
  703. kQ3UnknownTypeText                EQU        'uktx'
  704. kQ3UnknownTypeBinary            EQU        'ukbn'
  705. kQ3ShapeTypeReference            EQU        'rfrn'
  706. kQ3ReferenceTypeExternal        EQU        'rfex'
  707. kQ3SharedTypeSet                EQU        'set '
  708. kQ3SetTypeAttribute                EQU        'attr'
  709. kQ3SharedTypeDrawContext        EQU        'dctx'
  710. kQ3DrawContextTypePixmap        EQU        'dpxp'
  711. kQ3DrawContextTypeMacintosh        EQU        'dmac'
  712. kQ3DrawContextTypeWin32DC        EQU        'dw32'
  713. kQ3DrawContextTypeDDSurface        EQU        'ddds'
  714. kQ3DrawContextTypeX11            EQU        'dx11'
  715. kQ3SharedTypeTexture            EQU        'txtr'
  716. kQ3TextureTypePixmap            EQU        'txpm'
  717. kQ3TextureTypeMipmap            EQU        'txmm'
  718. kQ3SharedTypeFile                EQU        'file'
  719. kQ3SharedTypeStorage            EQU        'strg'
  720. kQ3StorageTypeMemory            EQU        'mems'
  721. kQ3MemoryStorageTypeHandle        EQU        'hndl'
  722. kQ3StorageTypeUnix                EQU        'uxst'
  723. kQ3UnixStorageTypePath            EQU        'unix'
  724. kQ3StorageTypeMacintosh            EQU        'macn'
  725. kQ3MacintoshStorageTypeFSSpec    EQU        'macp'
  726. kQ3StorageTypeWin32                EQU        'wist'
  727. kQ3SharedTypeString                EQU        'strn'
  728. kQ3StringTypeCString            EQU        'strc'
  729. kQ3SharedTypeShapePart            EQU        'sprt'
  730. kQ3ShapePartTypeMeshPart        EQU        'spmh'
  731. kQ3MeshPartTypeMeshFacePart        EQU        'mfac'
  732. kQ3MeshPartTypeMeshEdgePart        EQU        'medg'
  733. kQ3MeshPartTypeMeshVertexPart    EQU        'mvtx'
  734. kQ3SharedTypeControllerState    EQU        'ctst'
  735. kQ3SharedTypeTracker            EQU        'trkr'
  736. kQ3SharedTypeViewHints            EQU        'vwhn'
  737. kQ3SharedTypeEndGroup            EQU        'endg'
  738. ; ******************************************************************************
  739. ; **                                                                             **
  740. ; **                            QuickDraw 3D System Routines                     **
  741. ; **                                                                             **
  742. ; ****************************************************************************
  743.  
  744. ;
  745. ; extern TQ3Status Q3Initialize(void )
  746. ;
  747.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  748.         IMPORT_CFM_FUNCTION Q3Initialize
  749.     ENDIF
  750.  
  751. ;
  752. ; extern TQ3Status Q3Exit(void )
  753. ;
  754.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  755.         IMPORT_CFM_FUNCTION Q3Exit
  756.     ENDIF
  757.  
  758. ;
  759. ; extern TQ3Boolean Q3IsInitialized(void )
  760. ;
  761.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  762.         IMPORT_CFM_FUNCTION Q3IsInitialized
  763.     ENDIF
  764.  
  765. ;
  766. ; extern TQ3Status Q3GetVersion(unsigned long *majorRevision, unsigned long *minorRevision)
  767. ;
  768.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  769.         IMPORT_CFM_FUNCTION Q3GetVersion
  770.     ENDIF
  771.  
  772. ; 
  773. ; *  Q3GetReleaseVersion returns the release version number,
  774. ; *  in the format of the first four bytes of a 'vers' resource
  775. ; *  (e.g. 0x01518000 ==> 1.5.1 release).
  776. ; 
  777.  
  778. ;
  779. ; extern TQ3Status Q3GetReleaseVersion(unsigned long *releaseRevision)
  780. ;
  781.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  782.         IMPORT_CFM_FUNCTION Q3GetReleaseVersion
  783.     ENDIF
  784.  
  785.  
  786. ; ******************************************************************************
  787. ; **                                                                             **
  788. ; **                            ObjectClass Routines                             **
  789. ; **                                                                             **
  790. ; ****************************************************************************
  791.  
  792. ;  
  793. ; *  New object system calls to query the object system.
  794. ; *
  795. ; *  These comments to move to the stubs file before final release, they 
  796. ; *  are here for documentation for developers using early seeds.
  797. ; 
  798.  
  799. ; 
  800. ; *  Given a class name as a string return the associated class type for the 
  801. ; *  class, may return kQ3Failure if the string representing the class is 
  802. ; *  invalid.
  803. ; 
  804.  
  805. ;
  806. ; extern TQ3Status Q3ObjectHierarchy_GetTypeFromString(TQ3ObjectClassNameString objectClassString, TQ3ObjectType *objectClassType)
  807. ;
  808.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  809.         IMPORT_CFM_FUNCTION Q3ObjectHierarchy_GetTypeFromString
  810.     ENDIF
  811.  
  812. ; 
  813. ; *  Given a class type as return the associated string for the class name, 
  814. ; *  may return kQ3Failure if the type representing the class is invalid.
  815. ; 
  816.  
  817. ;
  818. ; extern TQ3Status Q3ObjectHierarchy_GetStringFromType(TQ3ObjectType objectClassType, TQ3ObjectClassNameString objectClassString)
  819. ;
  820.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  821.         IMPORT_CFM_FUNCTION Q3ObjectHierarchy_GetStringFromType
  822.     ENDIF
  823.  
  824. ;  
  825. ; *  Return true if the class with this type is registered, false if not 
  826. ; 
  827.  
  828. ;
  829. ; extern TQ3Boolean Q3ObjectHierarchy_IsTypeRegistered(TQ3ObjectType objectClassType)
  830. ;
  831.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  832.         IMPORT_CFM_FUNCTION Q3ObjectHierarchy_IsTypeRegistered
  833.     ENDIF
  834.  
  835. ;  
  836. ; *  Return true if the class with this name is registered, false if not 
  837. ; 
  838.  
  839. ;
  840. ; extern TQ3Boolean Q3ObjectHierarchy_IsNameRegistered(const char *objectClassName)
  841. ;
  842.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  843.         IMPORT_CFM_FUNCTION Q3ObjectHierarchy_IsNameRegistered
  844.     ENDIF
  845.  
  846. ; 
  847. ; * TQ3SubClassData is used when querying the object system for
  848. ; * the subclasses of a particular parent type:
  849. ; 
  850.  
  851. TQ3SubClassData            RECORD 0
  852. numClasses                 ds.l    1                ; offset: $0 (0)        ;  the # of subclass types found for a parent class 
  853. classTypes                 ds.l    1                ; offset: $4 (4)        ;  an array containing the class types 
  854. sizeof                     EQU *                    ; size:   $8 (8)
  855.                         ENDR
  856. ; 
  857. ; *  Given a parent type and an instance of the TQ3SubClassData struct fill
  858. ; *  it in with the number and class types of all of the subclasses immediately
  859. ; *  below the parent in the class hierarchy.  Return kQ3Success to indicate no
  860. ; *  errors occurred, else kQ3Failure.
  861. ; *
  862. ; *  NOTE:  This function will allocate memory for the classTypes array.  Be 
  863. ; *    sure to call Q3ObjectClass_EmptySubClassData to free this memory up.
  864. ; 
  865.  
  866. ;
  867. ; extern TQ3Status Q3ObjectHierarchy_GetSubClassData(TQ3ObjectType objectClassType, TQ3SubClassData *subClassData)
  868. ;
  869.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  870.         IMPORT_CFM_FUNCTION Q3ObjectHierarchy_GetSubClassData
  871.     ENDIF
  872.  
  873. ; 
  874. ; *  Given an instance of the TQ3SubClassData struct free all memory allocated 
  875. ; *    by the Q3ObjectClass_GetSubClassData call.
  876. ; *
  877. ; *  NOTE: This call MUST be made after a call to Q3ObjectClass_GetSubClassData
  878. ; *  to avoid memory leaks.
  879. ; 
  880.  
  881. ;
  882. ; extern TQ3Status Q3ObjectHierarchy_EmptySubClassData(TQ3SubClassData *subClassData)
  883. ;
  884.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  885.         IMPORT_CFM_FUNCTION Q3ObjectHierarchy_EmptySubClassData
  886.     ENDIF
  887.  
  888.  
  889. ; ******************************************************************************
  890. ; **                                                                             **
  891. ; **                                Object Routines                                 **
  892. ; **                                                                             **
  893. ; ****************************************************************************
  894.  
  895. ;
  896. ; extern TQ3Status Q3Object_Dispose(TQ3Object object)
  897. ;
  898.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  899.         IMPORT_CFM_FUNCTION Q3Object_Dispose
  900.     ENDIF
  901.  
  902. ;
  903. ; extern TQ3Object Q3Object_Duplicate(TQ3Object object)
  904. ;
  905.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  906.         IMPORT_CFM_FUNCTION Q3Object_Duplicate
  907.     ENDIF
  908.  
  909. ;
  910. ; extern TQ3Status Q3Object_Submit(TQ3Object object, TQ3ViewObject view)
  911. ;
  912.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  913.         IMPORT_CFM_FUNCTION Q3Object_Submit
  914.     ENDIF
  915.  
  916. ;
  917. ; extern TQ3Boolean Q3Object_IsDrawable(TQ3Object object)
  918. ;
  919.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  920.         IMPORT_CFM_FUNCTION Q3Object_IsDrawable
  921.     ENDIF
  922.  
  923. ;
  924. ; extern TQ3Boolean Q3Object_IsWritable(TQ3Object object, TQ3FileObject theFile)
  925. ;
  926.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  927.         IMPORT_CFM_FUNCTION Q3Object_IsWritable
  928.     ENDIF
  929.  
  930.  
  931. ; ******************************************************************************
  932. ; **                                                                             **
  933. ; **                            Object Type Routines                             **
  934. ; **                                                                             **
  935. ; ****************************************************************************
  936.  
  937. ;
  938. ; extern TQ3ObjectType Q3Object_GetType(TQ3Object object)
  939. ;
  940.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  941.         IMPORT_CFM_FUNCTION Q3Object_GetType
  942.     ENDIF
  943.  
  944. ;
  945. ; extern TQ3ObjectType Q3Object_GetLeafType(TQ3Object object)
  946. ;
  947.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  948.         IMPORT_CFM_FUNCTION Q3Object_GetLeafType
  949.     ENDIF
  950.  
  951. ;
  952. ; extern TQ3Boolean Q3Object_IsType(TQ3Object object, TQ3ObjectType theType)
  953. ;
  954.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  955.         IMPORT_CFM_FUNCTION Q3Object_IsType
  956.     ENDIF
  957.  
  958.  
  959. ; ******************************************************************************
  960. ; **                                                                             **
  961. ; **                            Shared Object Routines                             **
  962. ; **                                                                             **
  963. ; ****************************************************************************
  964.  
  965. ;
  966. ; extern TQ3ObjectType Q3Shared_GetType(TQ3SharedObject sharedObject)
  967. ;
  968.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  969.         IMPORT_CFM_FUNCTION Q3Shared_GetType
  970.     ENDIF
  971.  
  972. ;
  973. ; extern TQ3SharedObject Q3Shared_GetReference(TQ3SharedObject sharedObject)
  974. ;
  975.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  976.         IMPORT_CFM_FUNCTION Q3Shared_GetReference
  977.     ENDIF
  978.  
  979. ;  
  980. ; *    Q3Shared_IsReferenced
  981. ; *        Returns kQ3True if there is more than one reference to sharedObject.
  982. ; *        Returns kQ3False if there is ONE reference to sharedObject.
  983. ; *    
  984. ; *    This call is intended to allow applications and plug-in objects to delete
  985. ; *    objects of which they hold THE ONLY REFERENCE. This is useful when
  986. ; *    caching objects, etc.
  987. ; *    
  988. ; *    Although many may be tempted, DO NOT DO THIS:
  989. ; *        while (Q3Shared_IsReferenced(foo)) { Q3Object_Dispose(foo); }
  990. ; *    
  991. ; *    Your application will crash and no one will buy it. Chapter 11 is 
  992. ; *    never fun (unless you short the stock). Thanks.
  993. ; 
  994.  
  995. ;
  996. ; extern TQ3Boolean Q3Shared_IsReferenced(TQ3SharedObject sharedObject)
  997. ;
  998.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  999.         IMPORT_CFM_FUNCTION Q3Shared_IsReferenced
  1000.     ENDIF
  1001.  
  1002. ; 
  1003. ; *    Q3Shared_GetEditIndex
  1004. ; *        Returns the "serial number" of sharedObject. Usefuly for caching 
  1005. ; *        object information. Returns 0 on error.
  1006. ; *        
  1007. ; *        Hold onto this number to determine if an object has changed since you
  1008. ; *        last built your caches... To validate, do:
  1009. ; *        
  1010. ; *        if (Q3Shared_GetEditIndex(foo) == oldFooEditIndex) {
  1011. ; *            // Cache is valid
  1012. ; *        } else {
  1013. ; *            // Cache is invalid
  1014. ; *            RebuildSomeSortOfCache(foo);
  1015. ; *            oldFooEditIndex = Q3Shared_GetEditIndex(foo);
  1016. ; *        }
  1017. ; 
  1018.  
  1019. ;
  1020. ; extern unsigned long Q3Shared_GetEditIndex(TQ3SharedObject sharedObject)
  1021. ;
  1022.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1023.         IMPORT_CFM_FUNCTION Q3Shared_GetEditIndex
  1024.     ENDIF
  1025.  
  1026. ; 
  1027. ; *    Q3Shared_Edited
  1028. ; *        Bumps the "serial number" of sharedObject to a different value. This
  1029. ; *        call is intended to be used solely from a plug-in object which is 
  1030. ; *        shared. Call this whenever your private instance data changes.
  1031. ; *        
  1032. ; *        Returns kQ3Failure iff sharedObject is not a shared object, OR
  1033. ; *            QuickDraw 3D isn't initialized.
  1034. ; 
  1035.  
  1036. ;
  1037. ; extern TQ3Status Q3Shared_Edited(TQ3SharedObject sharedObject)
  1038. ;
  1039.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1040.         IMPORT_CFM_FUNCTION Q3Shared_Edited
  1041.     ENDIF
  1042.  
  1043.  
  1044. ; ******************************************************************************
  1045. ; **                                                                             **
  1046. ; **                                Shape Routines                                 **
  1047. ; **                                                                             **
  1048. ; ****************************************************************************
  1049.  
  1050. ; 
  1051. ; *    QuickDraw 3D 1.5 Note:
  1052. ; *
  1053. ; *    Shapes and Sets are now (sort of) polymorphic.
  1054. ; *
  1055. ; *        You may call Q3Shape_Foo or Q3Set_Foo on a shape or a set.
  1056. ; *        The following calls are identical, in implementation:
  1057. ; *
  1058. ; *            Q3Shape_GetElement            =    Q3Set_Get
  1059. ; *            Q3Shape_AddElement            =    Q3Set_Add
  1060. ; *            Q3Shape_ContainsElement        =    Q3Set_Contains
  1061. ; *            Q3Shape_GetNextElementType    =    Q3Set_GetNextElementType
  1062. ; *            Q3Shape_EmptyElements        =    Q3Set_Empty
  1063. ; *            Q3Shape_ClearElement        =    Q3Set_Clear
  1064. ; *
  1065. ; *    All of these calls accept a shape or a set as their first parameter.
  1066. ; *
  1067. ; *    The Q3Shape_GetSet and Q3ShapeSetSet calls are implemented via a new
  1068. ; *    element type kQ3ElementTypeSet. See the note above about 
  1069. ; *    kQ3ElementTypeSet;
  1070. ; *
  1071. ; *    It is important to note that the new Q3Shape_...Element... calls do not
  1072. ; *    create a set on a shape and then add the element to it. This data is
  1073. ; *    attached directly to the shape. Therefore, it is possible for an element
  1074. ; *    to exist on a shape without a set existing on it as well. 
  1075. ; *
  1076. ; *    In your application, if you attach an element to a shape like this:
  1077. ; *        (this isn't checking for errors for simplicity)
  1078. ; *
  1079. ; *        set = Q3Set_New();
  1080. ; *        Q3Set_AddElement(set, kMyElemType, &data);
  1081. ; *        Q3Shape_SetSet(shape, set);
  1082. ; *
  1083. ; *    You should retrieve it in the same manner:
  1084. ; *
  1085. ; *        Q3Shape_GetSet(shape, &set);
  1086. ; *        if (Q3Set_Contains(set, kMyElemType) == kTrue) {
  1087. ; *            Q3Set_Get(set, kMyElemType, &data);
  1088. ; *        }
  1089. ; *
  1090. ; *    Similarly, if you attach data to a shape with the new calls:
  1091. ; *
  1092. ; *        Q3Shape_AddElement(shape, kMyElemType, &data);
  1093. ; *
  1094. ; *    You should retrieve it in the same manner:
  1095. ; *
  1096. ; *        if (Q3Shape_ContainsElement(set, kMyElemType) == kTrue) {
  1097. ; *            Q3Shape_GetElement(set, kMyElemType, &data);
  1098. ; *        }
  1099. ; *
  1100. ; *    This really becomes an issue when dealing with version 1.0 and version 1.1 
  1101. ; *    metafiles.
  1102. ; *
  1103. ; *    When attempting to find a particular element on a shape, you should
  1104. ; *    first check with Q3Shape_GetNextElementType or Q3Shape_GetElement, then,
  1105. ; *    Q3Shape_GetSet(s, &set) (or Q3Shape_GetElement(s, kQ3ElementTypeSet, &set))
  1106. ; *    and then Q3Shape_GetElement(set, ...).
  1107. ; *
  1108. ; *    In terms of implementation, Q3Shape_SetSet and Q3Shape_GetSet should only be
  1109. ; *    used for sets of information that are shared among multiple shapes.
  1110. ; *    
  1111. ; *    Q3Shape_AddElement, Q3Shape_GetElement, etc. calls should only be used
  1112. ; *    for elements that are unique for a particular shape.
  1113. ; *    
  1114. ; 
  1115.  
  1116. ;
  1117. ; extern TQ3ObjectType Q3Shape_GetType(TQ3ShapeObject shape)
  1118. ;
  1119.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1120.         IMPORT_CFM_FUNCTION Q3Shape_GetType
  1121.     ENDIF
  1122.  
  1123. ;
  1124. ; extern TQ3Status Q3Shape_GetSet(TQ3ShapeObject shape, TQ3SetObject *theSet)
  1125. ;
  1126.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1127.         IMPORT_CFM_FUNCTION Q3Shape_GetSet
  1128.     ENDIF
  1129.  
  1130. ;
  1131. ; extern TQ3Status Q3Shape_SetSet(TQ3ShapeObject shape, TQ3SetObject theSet)
  1132. ;
  1133.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1134.         IMPORT_CFM_FUNCTION Q3Shape_SetSet
  1135.     ENDIF
  1136.  
  1137. ;
  1138. ; extern TQ3Status Q3Shape_AddElement(TQ3ShapeObject shape, TQ3ElementType theType, const void *data)
  1139. ;
  1140.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1141.         IMPORT_CFM_FUNCTION Q3Shape_AddElement
  1142.     ENDIF
  1143.  
  1144. ;
  1145. ; extern TQ3Status Q3Shape_GetElement(TQ3ShapeObject shape, TQ3ElementType theType, void *data)
  1146. ;
  1147.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1148.         IMPORT_CFM_FUNCTION Q3Shape_GetElement
  1149.     ENDIF
  1150.  
  1151. ;
  1152. ; extern TQ3Boolean Q3Shape_ContainsElement(TQ3ShapeObject shape, TQ3ElementType theType)
  1153. ;
  1154.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1155.         IMPORT_CFM_FUNCTION Q3Shape_ContainsElement
  1156.     ENDIF
  1157.  
  1158. ;
  1159. ; extern TQ3Status Q3Shape_GetNextElementType(TQ3ShapeObject shape, TQ3ElementType *theType)
  1160. ;
  1161.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1162.         IMPORT_CFM_FUNCTION Q3Shape_GetNextElementType
  1163.     ENDIF
  1164.  
  1165. ;
  1166. ; extern TQ3Status Q3Shape_EmptyElements(TQ3ShapeObject shape)
  1167. ;
  1168.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1169.         IMPORT_CFM_FUNCTION Q3Shape_EmptyElements
  1170.     ENDIF
  1171.  
  1172. ;
  1173. ; extern TQ3Status Q3Shape_ClearElement(TQ3ShapeObject shape, TQ3ElementType theType)
  1174. ;
  1175.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1176.         IMPORT_CFM_FUNCTION Q3Shape_ClearElement
  1177.     ENDIF
  1178.  
  1179.  
  1180. ; ******************************************************************************
  1181. ; **                                                                             **
  1182. ; **                            Color Table Routines                             **
  1183. ; **                                                                             **
  1184. ; ****************************************************************************
  1185.  
  1186. ;
  1187. ; extern TQ3Status Q3Bitmap_Empty(TQ3Bitmap *bitmap)
  1188. ;
  1189.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1190.         IMPORT_CFM_FUNCTION Q3Bitmap_Empty
  1191.     ENDIF
  1192.  
  1193. ;
  1194. ; extern unsigned long Q3Bitmap_GetImageSize(unsigned long width, unsigned long height)
  1195. ;
  1196.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  1197.         IMPORT_CFM_FUNCTION Q3Bitmap_GetImageSize
  1198.     ENDIF
  1199.  
  1200.  
  1201.  
  1202.     ENDIF ; __QD3D__ 
  1203.  
  1204.